InĀ [1]:
from pathlib import Path
from compare import ReferenceComparer, get_last_two_commits
Find commits to compareĀ¶
By default, the notebook compares last two commits(ref1hash is the older one and ref2hash is the newer one). You can customise this by changing the ref1_hash and ref2_hash variables or by providing REF1_HASH and REF2_HASH commit values. You can also provide custom spectrum paths for the two hashes with respect to the root directory for that commit.
InĀ [2]:
import os
ref1_hash = os.getenv('REF1_HASH')
ref2_hash = os.getenv('REF2_HASH')
if not (ref1_hash and ref2_hash):
ref1_hash, ref2_hash = get_last_two_commits()
if not (ref1_hash and ref2_hash):
raise ValueError("Could not get commit hashes.")
if os.getenv('CUSTOM_REF1_SPECTRUM_PATH'):
custom_ref1_spectrum_path = os.getenv('CUSTOM_REF1_SPECTRUM_PATH')
else:
custom_ref1_spectrum_path = 'tardis/spectrum/tests/test_spectrum_solver/test_spectrum_solver/TestSpectrumSolver.h5'
if os.getenv('CUSTOM_REF2_SPECTRUM_PATH'):
custom_ref2_spectrum_path = os.getenv('CUSTOM_REF2_SPECTRUM_PATH')
else:
custom_ref2_spectrum_path = 'tardis/spectrum/tests/test_spectrum_solver/test_spectrum_solver/TestSpectrumSolver.h5'
InĀ [3]:
ref1_hash, ref2_hash
Out[3]:
('84e768462f20f09fbccc05625cdcc1d8ffbe404c',
'31a79873a86abb5f428d4361134da6c3f1501f07')
Example ValuesĀ¶
Below are example values you can test the notebook with.
InĀ [4]:
# ref1_hash="170f1a2c0d8c6db518a4b9a0f4cb9b657aaa61b6"
# ref2_hash="d9fd3bb659d185bd9ece10b8e2175cf497ea84c5"
# custom_ref1_spectrum_path = 'tardis/spectrum/tests/test_spectrum_solver/test_spectrum_solver/TestSpectrumSolver.h5'
# custom_ref2_spectrum_path = 'test_spectrum_solver/test_spectrum_solver/TestSpectrumSolver.h5'
Initialise the ReferenceComparer classĀ¶
InĀ [5]:
comparer = ReferenceComparer(ref1_hash=ref1_hash, ref2_hash=ref2_hash, print_path=True)
comparer.setup()
comparer.diff_analyzer.display_diff_tree(comparer.dcmp)
Created temporary directory at /tmp/ref_compare___7utkph
ā .github/ ā ā actions/ ā ā ā setup_env/ ā ā workflows/ ā arepo_data/
ā atom_data/
ā ā nlte_atom_data/
ā ā stardis_atom_data/
ā tardis/ ā ā opacities/ ā ā ā tests/ ā ā ā ā test_tau_sobolev/ ā ā plasma/ ā ā ā equilibrium/ ā ā ā ā tests/ ā ā ā ā ā test_level_populations/ ā ā ā ā ā ā test_level_population_solver/ ā ā ā ā ā test_rate_matrix/ ā ā ā tests/ ā ā ā ā test_complete_plasmas/ ā ā ā ā ā test_plasma/ ā ā ā ā ā ā± plasma_unittest_disable_electron_scattering_False.h5 ā ā ā ā ā ā± plasma_unittest_disable_electron_scattering_True.h5 ā ā ā ā ā ā± plasma_unittest_excitation_dilute-lte.h5 ā ā ā ā ā ā± plasma_unittest_excitation_lte.h5 ā ā ā ā ā ā± plasma_unittest_helium_treatment_recomb-nlte.h5 ā ā ā ā ā ā± plasma_unittest_helium_treatment_recomb-nlte_delta_treatment_0.5.h5 ā ā ā ā ā ā± plasma_unittest_initial_t_inner_10000 K.h5 ā ā ā ā ā ā± plasma_unittest_initial_t_rad_10000 K.h5 ā ā ā ā ā ā± plasma_unittest_ionization_lte.h5 ā ā ā ā ā ā± plasma_unittest_ionization_nebular.h5 ā ā ā ā ā ā± plasma_unittest_line_interaction_type_downbranch.h5 ā ā ā ā ā ā± plasma_unittest_line_interaction_type_macroatom.h5 ā ā ā ā ā ā± plasma_unittest_line_interaction_type_scatter.h5 ā ā ā ā ā ā± plasma_unittest_nlte.h5 ā ā ā ā ā ā± plasma_unittest_nlte_classical_nebular.h5 ā ā ā ā ā ā± plasma_unittest_nlte_coronal_approximation.h5 ā ā ā ā ā ā± plasma_unittest_radiative_rates_type_blackbody.h5 ā ā ā ā ā ā± plasma_unittest_radiative_rates_type_detailed.h5 ā ā ā ā ā ā± plasma_unittest_radiative_rates_type_detailed_w_epsilon_1e-10.h5 ā ā ā ā ā ā± plasma_unittest_radiative_rates_type_dilute-blackbody.h5 ā ā ā ā test_hdf_plasma/ ā ā ā ā test_nlte_excitation/ ā ā ā ā test_nlte_solver/ ā ā ā ā test_plasma_continuum/ ā ā ā ā test_tardis_model_density_config/ ā ā simulation/ ā ā ā tests/ ā ā ā ā test_simulation/ ā ā spectrum/ ā ā ā tests/ ā ā ā ā test_spectrum_solver/ ā ā ā ā ā test_spectrum_solver/
ā ā tests/ ā ā ā test_tardis_full/ ā ā ā ā test_transport_simple/
ā ā ā test_tardis_full_formal_integral/ ā ā ā ā test_transport_simple_formal_integral/ ā ā transport/ ā ā ā montecarlo/ ā ā ā ā tests/ ā ā ā ā ā test_continuum/
ā ā ā ā ā test_montecarlo_main_loop/ ā ā ā ā ā test_packet_source/ ā ā ā ā ā ā test_black_body_simple_source/ ā ā ā ā ā ā test_black_body_simple_source_rel/ ā ā ā ā ā test_rpacket_tracker/ ā ā ā ā ā test_weighted_packet_source/ ā ā ā ā ā ā test_black_body_weighted_source/ ā ā visualization/ ā ā ā tools/ ā ā ā ā tests/ ā ā ā ā ā test_liv_plot/ ā ā ā ā ā ā test_liv_plotter/ ā ā ā ā ā test_sdec_plot/ ā ā ā ā ā ā test_sdec_plotter/
InĀ [6]:
comparer.compare()
Error comparing item: /simulation/plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /simulation/plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /simulation/plasma/yg_interp unsupported operand type(s) for -: 'PchipInterpolator' and 'PchipInterpolator'
Error comparing item: /simulation/plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
================================================== Summary for test_montecarlo_continuum.h5: Total number of keys- in ref1: 148, in ref2: 148 Number of keys with different names in ref1 and ref2: 0 Number of keys with same name but different data in ref1 and ref2: 1 Number of totally same keys: 146 ==================================================
Error comparing item: /simulation/plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Error comparing item: /simulation/plasma/dilute_planckian_radiation_field No module named 'tardis.plasma.radiation_field'
Testing individual filesĀ¶
You can compare individual files too. Below example would work if you used example commits.
InĀ [7]:
# comparer.hdf_comparator.summarise_changes_hdf("test_generate_plot_ply__plotter_generate_plot_ply1__.h5",
# Path(comparer.ref1_path) / "tardis/visualization/tools/tests/test_liv_plot/test_liv_plotter",
# Path(comparer.ref2_path) / "tardis/visualization/tools/tests/test_liv_plot/test_liv_plotter"
# )
HDF File ComparisonĀ¶
Below graph visualises all the HDF files that changed. Each block represents a key that changed, hovering on that block would show relative percentage change for that key.
InĀ [8]:
fig_same_name = comparer.generate_graph("different keys same name")
fig_different_keys = comparer.generate_graph("different keys")
Generating graph with updated hovertemplate Generating graph with updated hovertemplate
InĀ [9]:
fig_different_keys
InĀ [10]:
fig_same_name.layout.width = 1000
fig_same_name
Spectrum ComparisonĀ¶
You can compare TARDIS spectra for the two commits and also provide a custom path for the spectra.
InĀ [11]:
comparer.compare_testspectrumsolver_hdf(
custom_ref1_path=Path(comparer.ref1_path) / custom_ref1_spectrum_path,
custom_ref2_path=Path(comparer.ref2_path) / custom_ref2_spectrum_path
)
/home/runner/work/tardis/tardis/tardis-regression-data/compare.py:332: UserWarning: This figure includes Axes that are not compatible with tight_layout, so results might be incorrect.
InĀ [12]:
comparer.teardown()
Removed temporary directory /tmp/ref_compare___7utkph